home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / DIAG / COMSET9.ARJ / COMSET9.DOC < prev    next >
Text File  |  1992-04-05  |  21KB  |  414 lines

  1.                   ___________________________________________
  2.                                   C O M S E T
  3.                             Modem / Uart Setup Program
  4.                          Version 9.0..release date 4/5/92
  5.              from Hank Volpe Copyright 1987,1988,1989,1990,1991,1992
  6.                              BBS Phone: 410-256-3631
  7.                            Voice Phone: 410-256-5767
  8.                   ___________________________________________
  9.         
  10.                                   Introduction
  11.     
  12.     Comset is a utility that is designed to setup a communications port 
  13.     and a AT (Hayes) Compatible smartmodem. Many modems, especially 
  14.     internals, do not have a method to reset the modem when it is 
  15.     activated, nor does an adequate method exist to setup the serial port
  16.     for use. 
  17.     
  18.     Comset will setup your serial port to any speed from 300 to 56000 bps 
  19.     and then check to see if your modem is on-line. If it isn't, Comset 
  20.     will perform a hardware reset to "wake" it up. Next a software reset 
  21.     is performed by sending the command ATZ. If the reply OK is received, 
  22.     you are informed that the modem is fine. If OK is not received, Comset 
  23.     will attempt 3 times to reset the modem before informing you of an 
  24.     error. If you have an external modem and it is off, Comset will abort 
  25.     after setting up the serial port to the desired baud rate.
  26.     
  27.  
  28.  
  29.        Comset Version 9.0 Documentation  copyright (c) 1992 by Hank Volpe
  30.                                      Page 2
  31.  
  32.     What's new in Version 9.0 ?
  33.     ---------------------------
  34.  
  35.     You can always download the latest version of Comset, plus get user
  36.     support on the Modem Doctor BBS (410-256-3631) 24 hrs a day. All
  37.     users, registered or shareware, are always welcome. Additionally,
  38.     you can find Comset on most national BBS systems. 
  39.  
  40.     As with most shareware products, comset continues to evolve due to good
  41.     feedback from users like yourself. The major improvements in Version 9
  42.     are in speed and code size. Modem setups are faster, and Uart only
  43.     setups happen without a visible delay. Also the Uart only setup mode
  44.     allows you to raise control lines DTR and RTS without the need for
  45.     an active modem or serial device. This could be a help to those
  46.     looking for serial cable problems, or setting up devices like serial
  47.     printers. Also, A new test was added to confirm that the baud rate
  48.     register actually set to the desired baud rate. It's one thing to tell
  49.     a chip to set, another that it does! 
  50.  
  51.     Finally, the top speed is now 57.6k. Acutally it always was,
  52.     but National Semiconductor, the makers of the 16450,16550,and 16550AFN 
  53.     chips refer to this speed as 56000. Well, so did I. Technically, the
  54.     baud clock on your serial port could have a 2.86% error at 56000, which
  55.     means if it was a positive error, your port speed would be 57600 baud.
  56.     Remember though, it could also be a minus error. This is why I and
  57.     National Semiconductor followed the conservative name approach and
  58.     picked 56000...but since no one else did, and to avoid confusion,
  59.     Comset 9 adopts the new nomenclature.
  60.  
  61.     
  62.              Some of the features of Comset include the following ;
  63.                       Level 1 options...Shareware Version
  64.     
  65.            ** User Selected baud rates from 300 to 57600 bps.
  66.            ** User Selected Comm port assignments [1 to 4].
  67.            ** Modem Status register testing.
  68.               - Comset tests the registers for DTR/RTS and Carrier Detect
  69.            ** Redirectable output..can be sent to a file for logging.
  70.               or used over any serial link.
  71.            ** RTS/CTS DTR/DSR Handshake testing.
  72.            ** Ability to setup the UART alone for dumb modems or
  73.               other serial devices up to 57.6K baud 
  74.            ** New "s" switch allows you to swap any comm pointers in memory
  75.            ** New "p" switch allows you to see your comm address assignments
  76.            ** Log in of Comm ports 3 & 4 to DOS for use by other programs
  77.               such as high level languages or applications.
  78.            ** Ability to set a uart up and raise control lines without
  79.               the need for an active serial device or modem.
  80.           
  81.            Registered users have access to these special features;
  82.            ** Batch file parameter passing and error reporting.
  83.            ** Ability to send custom Hayes command strings to the modem
  84.              using a simple ASCII text file  
  85.  
  86.        Comset Version 9.0 Documentation  copyright (c) 1992 by Hank Volpe
  87.                                      Page 3
  88.  
  89.                                 I. USING COMSET
  90.                                 ----------------
  91.  
  92.                     The usage syntax for Comset is simple. 
  93.  
  94.                              COMSET [speed] [port] U
  95.                                        or
  96.                              COMSET [speed] [port]
  97.                                        or
  98.                                     COMSET h
  99.                                        or
  100.                                     COMSET i
  101.                                        or
  102.                                     COMSET p
  103.                                        or
  104.                             COMSET s  [port] [port]
  105.     
  106.                       [speed] and [port] are user options
  107.                       u tells Comset to set the UART only
  108.                       h invokes runtime help for the user
  109.                       i shows you revision and program information
  110.                       p peeks at your comm port memory address assignments
  111.                       s swaps the memory address assignments between the
  112.                          first port you entered and the second.
  113.     
  114.     Comset is easy to use. Typing COMSET from the dos prompt will 
  115.     automatically attempt to set up serial port Com1 to 2400 bps and 
  116.     attempt to wake up its modem. Selecting a different speed involves 
  117.     only adding the speed after the word Comset...ie COMSET 1200 sets 
  118.     serial port COM1 to 1200 bps instead of the default 2400. Trailing 
  119.     zeros are not necessary, so you could also type COMSET 12 to set up 
  120.     serial port COM1 to 1200 bps. If you wish to use a different serial 
  121.     port, add that after the speed...ie COMSET 24 2 will set serial port 
  122.     Com2 to 2400 bps. If you accidentally enter an invalid baud rate, the 
  123.     default of 2400 bps will be used. If you accidentally enter an invalid 
  124.     range of comm ports, the default of COM1 will be used. Defaults are 
  125.     always used if the user does not supply speed and port. Typing  a U 
  126.     after any option instructs Comset to setup the  serial port only and 
  127.     not to look for a modem.  This is handy for setting up  serial 
  128.     printers or other dumb devices to speeds  higher than 9600 baud.  
  129.     Mode.com from dos will do the same, but not at  57600 baud, and not
  130.     on all machines!.   
  131.     
  132.     Typing Comset p will display all of the comm port addresses logged 
  133.     into Dos. This can be handy when you are trying to configure a serial 
  134.     card for proper addresses.
  135.     
  136.     Typing Comset s will swap the address assignments in memory of com1 
  137.     and com2. If you entered comset s 1 4, then the address assignments 
  138.     will be swapped between com1 and com4 instead of com1 and com2. Any 
  139.     valid port from 1 to 4 can be used. 
  140.     
  141.  
  142.        Comset Version 9.0 Documentation  copyright (c) 1992 by Hank Volpe
  143.                                      Page 4
  144.     
  145.     
  146.     Typing COMSET h will bring up a runtime summary of features and other 
  147.     helpful information. Ideally, Comset should be run out of your 
  148.     autoexec.bat file when you  first turn on your computer. Internal 
  149.     modem users can appreciate the fact that probably 2 or 3 times out of 
  150.     a 100 their internal modem does not "wake-up" properly when the 
  151.     computer is first turned on, and this can hang-up some communications 
  152.     programs. Also, BBS sysops sometimes experience problems with modems 
  153.     when stopping the BBS and trying to use the modem to call out.  This 
  154.     is why Comset was written!
  155.     
  156.                          II. SERIAL PORT INFORMATION 
  157.                          ---------------------------
  158.         
  159.     Comset supports all the industry standard Serial Port address    
  160.     assignments for modems.  Almost all PC-modems allow you to use COM1-4, 
  161.     however only specific software  can use COM3 or COM4 on most machines. 
  162.     Comset will not only use COM3 and COM4 itself, but it will log those 
  163.     ports into DOS for use by other programs such as high-level languages 
  164.     and applications (something that under normal conditions can't be done 
  165.     with an IBM-PC or most clones without special software). Using the new 
  166.     "s" feature, you can also swap COM3 to COM1's address for those 
  167.     programs that cannot access a COM3 or COM4. Using the "p" feature, you 
  168.     can find out what serial port assignments your computer is using.
  169.  
  170.  
  171.                         III ERROR REPORTING INFORMATION
  172.                         -------------------------------
  173.         
  174.     Comset checks your serial port in three distinct steps;    
  175.     1) Set the Serial Port computer UART to the desired baud rate and 
  176.     raise the DTR and RTS lines. If a serial port is not detected, Comset 
  177.     aborts and displays the message that there is no serial port with that 
  178.     COMM designation your system.
  179.     
  180.     2) Check that DSR and CTS are returning from the modem, if not report 
  181.     an error and stop testing.
  182.         
  183.     3 a)If steps 1 & 2 are successful, wake up the modem by sending the 
  184.     command string "ATZ". If OK is received, report all is  Normal and 
  185.     leave the RTS and DTR lines active.
  186.         
  187.       b)If the modem did not wake up, issue a more advanced hardware and
  188.     software command string to reset and wake up the modem. Three attempts 
  189.     are made..if it fails, the RTS and DTR lines are turned off. This 
  190.     could happen
  191.     
  192.     if you tell Comset to test a serial port that does not have a 
  193.     compatible modem attached. In that case, a "failure" of this kind 
  194.     would be "normal" for your system.
  195.         
  196.  
  197.        Comset Version 9.0 Documentation  copyright (c) 1992 by Hank Volpe
  198.                                      Page 5
  199.     
  200.     You can redirect the output of Comset to a file if you wish to 
  201.     maintain a log of each initialization. To do this, just use the 
  202.     command string    
  203.     
  204.                 COMSET [speed] [port] >> comset.log
  205.     
  206.     Speed and port are optional. The >> symbol tells dos to make a file  
  207.     called comset.log and append it each time Comset is run.
  208.     
  209.     
  210.     
  211.                      IV FULL FEATURE USE AND ERROR REPORTING
  212.                      ---------------------------------------
  213.         
  214.     Registered Users of Comset receive some advanced features, some of 
  215.     which were described above in previous sections. An additional feature 
  216.     of the registered version is that of error-code reporting. Error code 
  217.     reporting simply stated passes "result-codes" from Comset to its 
  218.     calling program. This allows you to write some advanced batch-file  
  219.     procedures or to take specific actions.
  220.         
  221.     Running the registered copy, additional information is displayed 
  222.     informing you of the Error code received. Also that error code can be 
  223.     interpreted by Dos Batch files using the ERRORLEVEL function. Under 
  224.     normal conditions, a result code of 0 is returned to the calling 
  225.     program. If something wrong is detected, an error code of 99 is 
  226.     returned to the calling program. 
  227.       
  228.     A simple use of this can be to start a communications program if the 
  229.     modem is ok, but if not, default to some other action...an example 
  230.     batch-file program looks like this;
  231.          
  232.         echo off
  233.         comset 24 1
  234.          IF ERRORLEVEL 99 goto stop
  235.         echo passed
  236.         goto exit
  237.         :stop
  238.         echo failed!
  239.         :exit
  240.         
  241.     Other uses are left up to your imagination...you could flash up help 
  242.     screens to the user like "HEY DUMMY...TURN ON THE MODEM!!!" or 
  243.     something similar. Combined with redirecting the output to a logging 
  244.     file, you could trace a history of failures or other actions.
  245.  
  246.        Comset Version 9.0 Documentation  copyright (c) 1992 by Hank Volpe
  247.                                      Page 6
  248.  
  249.     Also,  new  in the registered version of Comset is the ability to send
  250.     custom setup strings to your modem from a simple text file. To use 
  251.     this feature, all you need to do is the following;
  252.     
  253.          1) Make a file with valid AT commands using edlin or any ASCII
  254.              text editor and name the file Comset.cmd
  255.     
  256.           2) Place this file in the same directory that you are running
  257.              comset out of. If you are running Comset from a path, then
  258.              you must have a Comset.cmd file in the directory you are
  259.              currently in for this feature to work. The reason for this
  260.              is  so  that  you  could have multiple  comset.cmd files
  261.              in different directories for different uses.
  262.     
  263.  
  264.     
  265.     When  Comset starts,  it will look for Comset.cmd in  the  current 
  266.     default directory,  and if it finds it,  it will send that command 
  267.     string to the modem instead of the ATZ command. An example of such a 
  268.     command set is the following;
  269.     
  270.         From dos, type edlin comset.cmd
  271.         when edlin starts, type I for insert.
  272.         Next, type AT M0 H1 then return
  273.         Next, type control-Z
  274.         Next, type e and the file will save.
  275.     
  276.     The next time you run comset, it will find the file comset.cmd and 
  277.     tell the modem to shut off the speaker and go off-hook.
  278.     
  279.     Any valid AT command set for your brand of modem can be sent.  The 
  280.     only restriction is that all these commands fit on one line and  the 
  281.     first two letters must be AT. 
  282.     
  283.     You  can  also redirect the output of this function to a  file  as 
  284.     explained above. Users of Modems can use this to capture the settings 
  285.     of their modem and save it in text form for future reference.
  286.  
  287.  
  288.        Comset Version 9.0 Documentation  copyright (c) 1992 by Hank Volpe
  289.                                      Page 7
  290.  
  291.                              V. REGISTRATION INFORMATION
  292.                                --------------------------
  293.     
  294.     You can freely make copies and distribute the shareware version of 
  295.     Comset over BBS systems or  public domain libraries as long as no fee 
  296.     for Comset is charged  (except duplication costs) and as long as 
  297.     Comset.exe is distributed along with this file Comset.doc. These may 
  298.     be archived together for use on a bbs system. Under no circumstances 
  299.     can the registered version of Comset be distributed. Each version 
  300.     displays "shareware" or "registered" when it is run from the dos 
  301.     prompt.
  302.         
  303.     Comset is copyrighted by Hank Volpe and is not public domain software.
  304.     Shareware version users are granted a limited license for its use. No 
  305.     warranties for Comset are stated, expressed or implied.
  306.         
  307.     Shareware authors continually provide computer users with low priced  
  308.     software compared to the traditional retail approach. If you register  
  309.     Comset, you will be able to use all the features ( Com1-4 support,   
  310.     auto-log in of Com3 and Com4 for Dos applications, advanced error 
  311.     reporting and batch file support).
  312.         
  313.     Registration is simple...and price is low. Comset is only $10, which  
  314.     includes the latest version and free maintenance updates. To register, 
  315.     send $10 along with your name and address to;
  316.         
  317.                                   Hank Volpe
  318.                                  PO Box 43214
  319.                                Baltimore MD 21236
  320.     
  321.  
  322.        Comset Version 9.0 Documentation  copyright (c) 1992 by Hank Volpe
  323.                                      Page 8
  324.     
  325.     
  326.                                    VI. ERROR MESSAGES
  327.     
  328.     THERE IS NO COMx IN YOUR SYSTEM -
  329.           Comset was instructed by the user to test a non-existent comm
  330.           port. This could happen automatically if you don't have a COM1
  331.           in your system. If this is the case, use the line
  332.           COMSET [speed] [port] to select your specific needs.
  333.     
  334.     
  335.     
  336.     MODEM NOT RESPONDING PROPERLY -
  337.           The modem under test did not set up even after 3 extensive
  338.           hardware and software attempts to do so. Either you have a non-
  339.           compatible or non-intelligent modem, or you are using the wrong
  340.           opening baud rate. Comset's defaults are 2400 bps and COM1. If
  341.           you only  have a 1200 or 300 bps modem, use the line
  342.           COMSET [speed] [port] and use a lower speed. Valid speeds are
  343.           300 bps,  1200 bps , 2400 bps [default], 4800 bps, 9600 bps,
  344.           19200 bps, 38400 bps, and 57600 bps. Trailing zeros are not 
  345.           necessary..ie 576 is 57600 bps. Any other values default
  346.           automatically to 2400 bps.
  347.     
  348.     
  349.           Comset Ver 8.0 Documentation  Copyright 1987-1991 Hank Volpe
  350.                                      Page 7
  351.     
  352.     MODEM APPEARS TO BE OFF OR DISCONNECTED -
  353.          The hardware handshaking pairs RTS/CTS or DTR/DSR are not 
  354.          communicating properly. This should NEVER happen on internal
  355.          modems unless the CTS signal is not enabled. Internal Modems
  356.          usually keep this signal at a logic 1, so if you see this error,
  357.          check your internal modem for proper strapping of the CTS and DSR
  358.          signals.
  359.         
  360.          If you have an external modem,and the power for the modem is on,
  361.          you will see this error message if you do not have the CTS signal
  362.          at a logic 1 or you have a defective or inadequate Serial Cable.
  363.          Most external modems have Dip-switches on the back for setting
  364.          the CTS signal. Normally the CTS follows the Serial Ports RTS and
  365.          the modem  DSR (sometimes called MR) follows the Serial Ports
  366.          DTR.
  367.         
  368.          In the case of an external modem you will see this error message
  369.          every time the modem has not been turned on. This is telling you
  370.          that your serial port hardware is fine, just that your modem is
  371.          off.
  372.  
  373.        Comset Version 9.0 Documentation  copyright (c) 1992 by Hank Volpe
  374.                                      Page 9
  375.     
  376.                             VII COMSET PROGRAM HISTORY
  377.                            --------------------------
  378.         
  379.         Version 1 - Simple Assy program fixed at 300 bps. Two versions
  380.                     COM1 and COM2.
  381.         
  382.         Version 2 - Baud rate raised to 1200 bps.
  383.         
  384.         Version 3 - Baud rate raised to 2400 bps.
  385.         
  386.         Version 4 - COM1 / COM2 support in one program.
  387.     
  388.         Version 5 - Major rewrite, added interrupt support, hardware
  389.                     and software testing, COM 1-4 support, Multiple
  390.                     baud rate support, error checking and reporting,
  391.                     and support for high speed modems to 19200 bps.
  392.     
  393.         Version 6 - This version adds the U parameter to allow for testing
  394.                     and setup of dumb modems and other serial devices.
  395.                     The registered version adds the ability to send a 
  396.                     custom command string from a file named comset.cmd
  397.                     to the modem in place of the normal ATZ command
  398.     
  399.         Version 7 - This version adds baud rates to 38.4K,improved Uart
  400.                     communications module.
  401.     
  402.         Version 8 - This version adds speeds to 56K baud, improved
  403.                     Uart communications module, addition of the
  404.                     comm port swap and comm address features
  405.     
  406.         Version 9 - Improves speed of routines, adds the ability for
  407.                     uart only setups not to require an active device,
  408.                     changes the top speed description to 57.6k, and
  409.                     adds a test to verify the baud rate register set
  410.                     to the desired baud rate
  411.         Current Software release is Version 9.0
  412.     
  413.     
  414.